home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / ratio10.zip / RATIO.DOC < prev    next >
Text File  |  1993-02-27  |  11KB  |  282 lines
  1.  
  2.                        ============================
  3.                                   RATIO!
  4.                        ============================
  5.  
  6.         One of the T&J Software Collection of multi-BBS door programs.
  7.            Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
  8.               UltraBBS, Telegard, TriBBS, Remote Access, and WWIV
  9.  
  10.                           (c)1993 T&J Software
  11.  
  12.                        VERSION 1.0      02/27/93
  13.  
  14.                                     By
  15.  
  16.                                Tom Wildoner
  17.                              397 West Broadway
  18.                               Jim Thorpe, PA
  19.                                   18229
  20.                             VOICE (717)325-9480
  21.  
  22.                                   From
  23.  
  24.                                The T&J BBS
  25.                               (717)325-9481
  26.                         1200/2400/9600/19200/38400
  27.                                24 Hours/Day
  28.  
  29.  
  30. LATEST VERSION:
  31. ===============
  32. Please call the T&J BBS for the latest version of this program.
  33.  
  34. DISTRIBUTION:
  35. =============
  36. You may make this file available for downloading from your BBS or you may
  37. upload it to any BBS of your choice, provided that you do not make any
  38. changes to the contents of the archive (ZIP file). The archive and its
  39. individual contents may not be used by any service that charges any money
  40. whatsoever, without the written permission of the author.
  41.  
  42. LEGALITIES:
  43. ===========
  44.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  45.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  46.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  47.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  48.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  49.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  50.       OR BREACH OF ANY WARRANTY.
  51.  
  52. PROGRAM DESCRIPTION:
  53. ====================
  54.  
  55. A simple door program to keep users out of doors if they don't keep
  56. a good upload/download ratio. You set the ratio to maintain in the
  57. SYSOP.CFG file. Let's say you put 20 in for the ratio. That means
  58. you want your users to keep at least a 20 DL/1 UL ratio in order to
  59. use the door.
  60.  
  61. A special file called RATIO.USR is included. If you have users who
  62. you want to bypass the ratio checking, just add their name in this
  63. text file.
  64.  
  65. If Ratio! finds a "bad user" it will create a file called BAD.BAD. The
  66. DOOR.BAT file will see it and skip the main door program and head back
  67. to the BBS (see the sample batch file included).
  68.  
  69.  
  70. NOTE:
  71. =====
  72.  
  73. The door will only operate properly using PCBOARD.SYS, DOOR.SYS,
  74. SFDOORS.DAT, or CHAIN.TXT.
  75.  
  76.  
  77. INSTALLATION:
  78. =============
  79.  
  80. Example configuration file for PCBOARD.SYS
  81. ------------------------------------------
  82.  
  83. C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  84. T&J Software        <=-  (Change this to your BBS name)
  85. Tom                 <=-  (The Sysop's first name)
  86. Wildoner            <=-  (The Sysop's last name)
  87.  
  88. Example configuration file for USERS.SYS
  89. ----------------------------------------
  90.  
  91. C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  92. T&J Software        <=-  (Change this to your BBS name)
  93. Tom                 <=-  (The Sysop's first name)
  94. Wildoner            <=-  (The Sysop's last name)
  95.  
  96. Example configuration file for DOOR.SYS
  97. ---------------------------------------
  98.  
  99. C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  100. T&J Software        <=-  (Change this to your BBS name)
  101. Tom                 <=-  (The Sysop's first name)
  102. Wildoner            <=-  (The Sysop's last name)
  103.  
  104. Example configuration file for USERINFO.DAT
  105. -------------------------------------------
  106.  
  107. C:\BBS\USERINFO.DAT <=-  (Full pathname of your USERINFO.DAT file)
  108. T&J Software        <=-  (Change this to your BBS name)
  109. Tom                 <=-  (The Sysop's first name)
  110. Wildoner            <=-  (The Sysop's last name)
  111. NOTE: DOOR.SYS must be in the SAME directory as USERINFO.DAT
  112.  
  113. Example configuration file for CALLINFO.BBS
  114. -------------------------------------------
  115.  
  116. C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  117. T&J Software        <=-  (Change this to your BBS name)
  118. Tom                 <=-  (The Sysop's first name)
  119. Wildoner            <=-  (The Sysop's last name)
  120.  
  121. Example configuration file for DORINFOx.DEF
  122. -------------------------------------------
  123.  
  124. C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  125.                           where 'x' is the BBS Node number.
  126. T&J Software        <=-  (Change this to your BBS name)
  127. Tom                 <=-  (The Sysop's first name)
  128. Wildoner            <=-  (The Sysop's last name)
  129.  
  130. Example configuration file for SFDOORS.DAT
  131. ------------------------------------------
  132.  
  133. C:\BBS\SFDOORS.DAT  <=-  (Full pathname of your SFDOORS.DAT file)
  134. T&J Software        <=-  (Change this to your BBS name)
  135. Tom                 <=-  (The Sysop's first name)
  136. Wildoner            <=-  (The Sysop's last name)
  137.  
  138. Example configuration file for CHAIN.TXT
  139. ----------------------------------------
  140.  
  141. C:\BBS\CHAIN.TXT    <=-  (Full pathname of your CHAIN.TXT file)
  142. T&J Software        <=-  (Change this to your BBS name)
  143. Tom                 <=-  (The Sysop's first name)
  144. Wildoner            <=-  (The Sysop's last name)
  145.  
  146. Example configuration file for GTUSER.BBS
  147. -----------------------------------------
  148.  
  149. C:\BBS\GTUSER.BBS   <=-  (Full pathname of your GTUSER.BBS file)
  150. T&J Software        <=-  (Change this to your BBS name)
  151. Tom                 <=-  (The Sysop's first name)
  152. Wildoner            <=-  (The Sysop's last name)
  153. 1                   <=-  (COM port number - defaults to 1)
  154. 1                   <=-  (Node number - defaults to 1)
  155.  
  156. This Door is multi-node  compatible so you may run more than 1 node from
  157. the same .CFG file provided the path to your system file (DORINFOx.DEF,
  158. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  159. variables, (q.v.)
  160.  
  161. Environment Variables
  162. =====================
  163.  
  164. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  165. variables. Non-PCBoard systems may also use these variables by including
  166. the following in either your BBS batch or AUTOEXEC.BAT
  167.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  168.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  169. Then in your Door .CFG file instead of putting C:\BBSDIR\DOOR.SYS, you
  170. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  171. .CFG file for multi-node operation!
  172.  
  173. To specify a non-standard IRQ, put the IRQ number after the .CFG on the
  174. command line.  For example:
  175.  
  176.      RATIO RATIO.CFG /5
  177. or using the PCBDRIVE procedure:   SET IRQ=5   and use
  178.      RATIO RATIO.CFG /%IRQ%
  179.  
  180. This tells the program to use IRQ 5 instead of the standard IRQ.
  181.  
  182.   Had reports of conflicts when using non-standard IRQ's on Novell/Netware
  183.  systems. Seems Novell also uses the / character so something went screwy
  184.  somewhere. So I added the * (asterisk) which may be used instead of the /
  185.  in case of a conflict. In other words, /%IRQ% and *%IRQ% will both work
  186.  and are interchangeable.
  187.  
  188. When specifying the location of the system file on line 1 of the doors .CFG
  189. file, you may use the environment variables %pcbdrive%, %pcbdir%, %pcbnode%,
  190. and %wcnodeid%. Some examples:
  191.  PCBoard: 
  192.    USERS.SYS in C:\PCB           - %pcbdrive%%pcbdir%\USERS.SYS
  193.    USERS.SYS in C:\PCB\NODE1     - %pcbdrive%%pcbdir%\NODE%pcbnode%\USERS.SYS
  194.  
  195.  Wildcat!:
  196.    USERINFO.DAT in C:\WC\NODE1   - C:\WC\NODE%wcnodeid%
  197.  
  198. Non-PCBoard systems may use the PCB environment variables by setting them
  199. in either AUTOEXEC.BAT or in the batch that runs the door. For example:
  200.  SET PCBDRIVE=C:
  201.  SET PCBDIR=\BBSDIR
  202.  SET PCBNODE=1
  203.  
  204. Fossil Driver Support
  205. ---------------------
  206. DoorFrame supports the use of Fossil drivers.  To tell your Door to use the
  207. Fossil driver instead of the standard COM ports, just put /FD on the command
  208. line when running the door. For example:
  209.      MYDOOR MYDOOR.CFG /FD
  210. indicates that a Fossil driver is present and should be used. If no Fossil
  211. driver is detected, DoorFrame will print a message to that effect and exit
  212. the door gracefully.
  213.  
  214.  
  215. Sysop Keys
  216. ==========
  217.  
  218. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  219.          written to DOOR.SYS and USERS.SYS
  220. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  221.          and/or written to DOOR.SYS and USERS.SYS
  222. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  223. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  224.          and/or written to DOOR.SYS and USERS.SYS
  225. F8    -  Returns the caller involuntarily to the BBS.
  226. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  227.          and/or written to DOOR.SYS and USERS.SYS
  228. F10   -  Activates SysOp CHAT mode within the DOOR.
  229. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  230. UP    -  Give the caller extra time while in the DOOR.  
  231. DN    -  Subtract time from the caller while in the DOOR. 
  232. HOME  -  HELP key for Status Line options.
  233. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  234. ALT-X -  PCBoard will exit after current caller logs off. Value is
  235.          passed to PCBoard. Not available on non-PCBoard systems.
  236.  
  237.  
  238. BATCH FILE SETUP!
  239. ================
  240.  
  241. ECHO OFF
  242. CD\WC30\DOOR\LEMON
  243. RATIO RATIO.CFG
  244. IF EXIST BAD.BAD GOTO QUIT
  245. LEMON LEMON.CFG
  246. :QUIT
  247. IF EXIST BAD.BAD DEL BAD.BAD
  248.  
  249. 1: Turn ECHO OFF -- not needed
  250. 2: Change to your door directory.
  251. 3: Run Ratio! -- if a bad user is found the program will create a
  252.    small file called BAD.BAD.
  253. 4: Checks to see if BAD.BAD was created -- if it was it will skip to
  254.    QUIT and bypass the real door. If the BAD.BAD file is not found
  255.    your real door will operate as normal.
  256. 5: Your actual door program (however many lines it takes).
  257. 6: Batch file branch if a bad user was found.
  258. 7: Delete the BAD.BAD file if it is there.
  259.  
  260. To run in LOCAL mode simply enter:  RATIO LOCAL
  261.  
  262.  
  263. FUTURE VERSIONS:
  264. ================
  265. --->> Let me know what you would like to see!
  266.  
  267. VERSION HISTORY:
  268. ================
  269. Version 1.00 ......... First release. 02/27/93
  270.  
  271. REGISTERING:
  272. ============
  273. None required. If you would like to send me a program you have written,
  274. that would be payment enough.
  275.  
  276.  
  277. That's all there is to it! If you have any problems or questions
  278. please feel free to call the T&J BBS at (717)325-9481 and join the
  279. T&J Software Conference.
  280.  
  281. See the registration form for other products from T&J Software.
  282.